The File Subsystem Type enables interacting with file system operations like copy, delete, get file size, etc. It also supports FTP operations like Download, Upload, Delete and check if a given path is a directory. It requires the
filemanager application
PROPERTIES
| Name |
File Subsystem |
| System ID |
07 |
| Connection String |
|
| Heartbeat Connection String |
|
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated.
Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Archives one or more files
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourceFiles |
NO |
A comma separated list of file paths to be archived. No trailing spaces between file paths are allowed. |
| DestinationPath |
NO |
The path of the resulting archive |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Source Path |
NO |
The path of the file to be copied. No folders are supported |
| Destination Path |
NO |
The destination of the copied file |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Source File |
NO |
The path of the file to be extracted |
| Destination Directory |
NO |
The directory to which the archive must be extracted. If the directory does not exist, it will be created. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Source Path |
NO |
The path of the directory to be moved |
| Destination Path |
NO |
The path of the moved directory. This must be a non existent folder path. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Calculate the CRC32 Checksum for a file.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| filePath |
NO |
The file path |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| checksum |
The calculated CRC32 checksum |
Asynchronously move the folder and its contents under a new parent folder.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory to move |
| destinationDir |
NO |
The path under which to move the directory to |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Starts to calculate the MD5 Checksum of the specified file. The response is received asynchronously, see Asynchronous Create MD5 Complete. Most callers should use the Async Create MD5 Checksum superstate instead.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the file to have its MD5 sum calculated |
| percent |
NO |
The percentage of the file to read to calculate checksum |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Starts archiving a file. The asynchronous response is received later, see File Archive Complete. Most users should be using the Async File move Archive Superstate or Uncompress instead.
To move the file synchronously, see File Move.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourceFiles |
NO |
A comma separated list of file paths to be archived. No trailing spaces between file paths are allowed. |
| DestinationPath |
NO |
The path of the resulting archive |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Starts copying a file to the specified destination. The asynchronous response is received later, see File Copy Complete.
To copy the file synchronously, see File Copy.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The destination of the copied file |
| SourcePath |
NO |
The path of the file to be copied. No folders are supported |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Starts extracting the specified file. The response is received asynchronously, see File Extract Complete. Most callers should use the Async File Extract superstate instead.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path of the file to be extracted |
| DestinationDirectory |
NO |
The directory to which the archive must be extracted. If the directory does not exist, it will be created. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Starts moving a file to the specified destination. The asynchronous response is received later, see File Move Complete. Most users should be using the Async File move SuperState instead.
To move the file synchronously, see File Move.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path of the directory to be moved |
| DestinationPath |
NO |
The path of the moved directory. This must be a non existent folder path. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Notification that the asynchronous calculation of the CRC32 checksum for a file is completed.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| checksum |
The CRC32 checksum result |
Start the asynchronous calculation of the CRC32 checksum for a file.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| filePath |
NO |
Path to the file for which the CRC32 checksum is calculated. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Calculates the MD5 checksum of the specified file. The request is made and an asynchronous response is received on completion.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| filePath |
NO |
The file path |
| percent |
NO |
The percentage of the file to read to calculate checksum |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| checksum |
The calculated checksum |
Calculates the MD5 checksum of the specified file. The request is made and an asynchronous response is received on completion. Use the 'Calculate Checksum' if the input type is STRING
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| filePath |
NO |
The path of the file to have its MD5 sum calculated |
| percent |
NO |
The percentage of the file to read to have its MD5 sum calculated |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| checksum |
The calculated MD5 sum |
Extracs an archived file.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| source |
NO |
The file to be extracted. This file can be a zip or a tar. |
| directory |
NO |
The directories where the contents will be extracted to. If this directory doesn't exist, it will be created. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Concatenates a parent and a leaf to produce a complete path. This call is platform dependent.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| name |
NO |
The final part of the desired concatenated path |
| parent |
NO |
The first part of the desired concatenated path |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| path |
The resulting concatenated path |
Response to the asynchronous folder content copy
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Deletes all files specified in the provided list. The file paths must be separated by commas with no trailing spaces.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| PathList |
NO |
A comma separated list of regular file paths thar must be deletd. No trailing space are allowed betwen file paths. |
| RemoveEmptyParentDir |
NO |
Remove the empty parent directory recursively. The default value is false. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Copy the filtered contents of the folder to the provided destination folder location. If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| destinationDir |
NO |
The directory path to copy the contents to. If it doesn't exist, it will be created. If it exists, its contents will be merged with the contents of the source direcotry. |
| dir |
NO |
The directory path from which to copy the contents |
| filter |
NO |
a regular expression to filter contents (includes files and directories) under dir that need to copy to destinationDir |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Asynchronously copy the filtered contents of the folder to the provided destination folder location. If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to copy the contents. |
| destinationDir |
NO |
The directory path to copy the contents to. If it doesn't exist, it will be created. If it exists, its contents will be merged with the contents of the source direcotry. |
| filter |
NO |
A regular expression to filter contents (includes files and directories) under dir that need to copy to destinationDir. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the asynchronous folder copy
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Create symbolic links to contents under the specify foder. If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| destinationDir |
NO |
The directory path to create symbolic link to. If it doesn't exist, it will be created. If it exists, its contents will be merged with the contents of the source direcotry. |
| dir |
NO |
The directory path from which to copy the contents |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the asynchronous folder content copy
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Copy the contents of the folder to the provided destination folder location.
If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to copy the contents |
| destinationDir |
NO |
The directory path to copy the contents to. If it doesn't exist, it will be created. If it exists, its contents will be merged with the contents of the source direcotry. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Asynchronously copy the contents of a folder to another folder.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to copy the contents. |
| destinationDir |
NO |
The directory path to copy the contents to. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Copy the folder and its contents to the destination folder.
If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory to copy |
| destinationDir |
NO |
The path under which to copy the directory to |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Create a file. If the file existed then overwrite it.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Content |
NO |
The file content, what should be written to the file. Ex: the metadata xml content. |
| Path |
NO |
The content file path, where the content will be written to. It should be start with /content. Ex: /content/test/ADI.xml |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Creates a folder. If the folder exists, returns success. Returns nack if the path exists and is not a folder. Returns nack if the folder create fails.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The path of directory to be created |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the Asynchronous Create MD5 Checksum call indicating completion of md5 hash calculation
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| checksum |
The resulting MD5 checksum |
Creates a symbolic link to a target file or directory
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| link |
NO |
The path of the symbolic link to create |
| target |
NO |
The target of the symbolic link |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
It will firstly delete the path(file or directory) rootPath/subPath, then recursively delete its parents of subPath if it's empty. Do not delete rootPath although it's empty.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| subPath |
NO |
DO NOT have .. and . in the path. It may cause unexpected result. Otherwise, please make sure which path need to delete. |
| rootPath |
NO |
A root path as a prefix of the subPath. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Asynchronously copy a folder under the destination folder
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory to copy |
| destinationDir |
NO |
The path under which to copy the directory to |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Removes the specified folder from the filesystem
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The path of the folder to be deleted |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Password |
NO |
The password to login in the FTP Server |
| Username |
NO |
The username to login in the FTP Server |
| Path |
NO |
The ftp url of the file or the folder to be deleted. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
FTP Download that works either for files or directories. It supports nested folders.
FTP User/Passwd must be provided in the message.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The local path where the file will be downloaded to. The filemanager application user must have write access to this folder. Ex.: /content/folder1 which means that SourcePath will be downloaded inside folder1. |
| Password |
NO |
The password to login in the FTP Server |
| SourcePath |
NO |
The ftp url of the file or directory to be downloaded. Known issue: Try to download a directory a (or any child) which name has spaces. |
| Username |
NO |
The username to login in the FTP Server |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Checks if a FTP path is a directory or a not (a file).
FTP User/Passwd must be set in the message.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Password |
NO |
The password to login in the FTP Server |
| Path |
NO |
The ftp url of the folder or file. Ex: ftp://host/folder1 |
| Username |
NO |
The username to login in the FTP Server |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| IsDirectory |
True if the remote file is a directory and false otherwise. False even when the file/Directory does not exists. |
Uploads a file or a directory to a remote directory. It supports nested directories.
FTP User/Passwd must be provided in the message
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The ftp url of directory where the local file or directory will be uploaded to. |
| Password |
NO |
The password to login in the FTP Server |
| SourcePath |
NO |
The path to the file or directory that must be uploaded. |
| Username |
NO |
The username to login in the FTP Server |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
It will firstly delete the path(file or directory) rootPath/subPath, then recursively delete its parents of subPath if it's empty. Do not delete rootPath although it's empty.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| rootPath |
NO |
A root path as a prefix of the subPath. |
| subPath |
NO |
DO NOT have .. and . in the path. It may cause unexpected result. Otherwise, please make sure which path need to delete. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Lists all files inside a directory except subdirectories.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The directory to be listed. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| Result |
The directory listing. |
Deletes a file or folder remotely on a FTP location. It supports removing nested directories.
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The ftp url of the file or the folder to be deleted. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
FTP Download that works either for files or directories. It supports nested folders.
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The local path where the file will be downloaded to. The filemanager application user must have write access to this folder. |
| SourcePath |
NO |
The ftp url of the file or directory to be downloaded. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Uploads a file or a directory to a remote directory.
For directory, the paramter name pattern would be applied to filter
files under it for uploading. It supports nested directories.
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The ftp url of directory where the local file or directory will be uploaded to. |
| FileNamePattern |
NO |
Regex pattern that used to filter files under directory for uploading to FTP. |
| SourcePath |
NO |
The path to the file or directory that must be uploaded. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Checks if a FTP path is a directory or a not (a file).
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The ftp url of the folder or file. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| IsDirectory |
True if the remote file is a directory and false otherwise |
Rename file/directory name on remote FTP location.
e.g.
FromName: ftp://ftp.server.com/path/filename.txt
ToName: newFilename.txt
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| FromName |
NO |
File name to be renamed from. It should contains the complete path of file/folder including ftp host |
| ToName |
NO |
File name to be renamed to, only supports rename in same directory. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
FTP Download or Upload that works only for files. If the SourcePath is a FTP location it works as FTP Download. Otherwise, it tests if the DestinationPath is a FTP location and works as FTP Upload.
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The source path, which can be a local file or a remote ftp location |
| DestinationPath |
NO |
The destination path, which can be a local file or a remote ftp location. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Uploads a file or a directory to a remote directory. It supports nested directories.
FTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The ftp url of directory where the local file or directory will be uploaded to. |
| SourcePath |
NO |
The path to the file or directory that must be uploaded. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the Asynchronous File Archive call indicating completion of the operation
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the Asynchronous File Copy call indicating completion of the operation
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Copies a file to the specified destination, synchronously. Use the 'Asynchronous File Copy Superstate' to copy large files.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path of the file to be copied |
| DestinationPath |
NO |
The destination of the copied file. If this is a directory, the file will be copied under this directory |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Deletes a file. Directories are not supported.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the regular file to be deleted |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the Asynchronous File Extract call indicating completion of the operation
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
list all the files and each file's size
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the directory or a specific file. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| Result |
The paths of all files in the directory or the path of the specific file, along with the file size. |
Checks if the source path is a directory
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The source path. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| IsDirectory |
True if the source path is a directory and false otherwise. |
Response to the Asynchronous File Move call indicating completion of the operation
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Moves a file to the specified destination, synchronously. Use the 'Asynchronous File Move Superstate' to copy large files.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path of the file to be moved |
| DestinationPath |
NO |
The destination of the file to be moved. If this is a directory the file will be moved under it. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Renames a file given by a complete SourcePath to a DestinationName which contains only the new file name.
If the given path is a directory it throws an exception.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path of the file to be renamed |
| DestinationName |
NO |
The new name of the file |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Gets the size, in bytes, of a regular file
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the file. Directories are not supported. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| FileSize |
The size of the file in bytes |
Returns a List of all the Folders that are children of the given Path.
Note that this message returns only the child folders, excluding files.
If a given Path desnt denote a folder, it will return an empty list.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the folder to be listed |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| Result |
The listing of the folder. Includes subdrectories. |
Gets the free space of the provided partition. This will not return the folder size of the given path. The Partition Size node can be used with this node to determine the total space used in a given partition.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the partition |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| FreeSpace |
Free space in bytes of the specified partition |
Returns the base name of the input, i.e. the name minus the full path and extension. This call is platform independent
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| path |
NO |
The path of the file |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| basename |
Base name of the path - without the parent or extension |
Returns the extension, i.e. the portion of the path after the last period, of the leaf element
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| path |
NO |
The file path |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| extension |
The extension of the file |
Returns the name of the file or directory denoted by the specified path
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| path |
NO |
Full file path e.g. /content/movie.mpg |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| name |
File name. For the path /content/movie.mpg the name is movie.mpg |
Returns the parent of the specified path
(file or directory)
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| path |
NO |
The file path |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| parent |
The parent of the file, i.e., the file path without the file name |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the file |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| LastModified |
The String value of last modified timestamp, like "1542165719000" |
Uploads a file or a directory to a remote directory using SFTP. It supports nested directories. SFTP User/Passwd are now passed as parameters.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Username |
NO |
The username to login in the SFTP Server |
| Password |
NO |
The password to login in the SFTP Server |
| SourcePath |
NO |
The path to the file or directory that must be uploaded. |
| DestinationPath |
NO |
The sftp url of directory where the local file or directory will be uploaded to. |
| PrivateKeyPath |
NO |
The path to the private key that use to login to sftp server. |
| Passphrase |
NO |
The passphrase to login in the SFTP Server |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the asynchronous folder content move
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Move the contents of a folder from the source folder to the destination folder. If the destination folder does not exist, it is created. Only contents match the filter will be moved.
If no filter is supplied, then all the files will be moved.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to move contents |
| destinationDir |
NO |
The new directory path to which to move the contents |
| filter |
NO |
a regular expression to filter contents(includes files and directories) under dir that need to move to destinationDir |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the asynchronous folder move
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Response to the asynchronous folder content move
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Move the contents of a folder from the source folder to the destination folder.
If the destination folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to move contents |
| destinationDir |
NO |
The new directory path to which to move the contents |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Move a folder and its contents to a new parent folder (retaining the name of the folder being moved).
If the destination parent folder does not exist, it is created.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory to move |
| destinationDir |
NO |
The path under which to move the directory to |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Gets the size of a partition in bytes. If the specified path is not a partition, returns the size of the containing partition.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The path of the partition |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| Size |
The size of the partitioin in bytes |
Message is used to download a file from HTTP/HTTPS url
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Url |
NO |
HTTP/HTTPS url pointing to the file to download |
| DestinationPath |
NO |
Destination folder where the file will be downloaded |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| Path |
linux path where the file is downloaded |
Deletes a file or folder remotely on a SFTP location. It supports removing nested directories. SFTP User/Passwd are now passed as parameters.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The sftp url of the file or the folder to be deleted. |
| Username |
NO |
The username to login in the SFTP Server |
| Password |
NO |
The password to login in the SFTP Server |
| PrivateKeyPath |
NO |
The path to the private key that use to login to sftp server. |
| Passphrase |
NO |
The passphrase to login in the SFTP Server. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The sftp url of the file or directory to be downloaded. Known issue: Try to download a directory a (or any child) which name has spaces. |
| DestinationPath |
NO |
The local path where the file will be downloaded to. The filemanager application user must have write access to this folder. Ex.: /content/folder1 which means that SourcePath will be downloaded inside folder1. |
| Username |
NO |
The username to login in the SFTP Server |
| Password |
NO |
The password to login in the SFTP Server |
| PrivateKeyPath |
NO |
The path to the private key that use to login to sftp server. |
| Passphrase |
NO |
The passphrase to login in the SFTP Server. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Checks if a File or directory exists on remote SFTP location. SFTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The sftp url of the file or the folder to be checked. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| IsExisting |
True if the remote file or directory exists. |
Deletes a file or folder remotely on a SFTP location. It supports removing nested directories. SFTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
The sftp url of the file or the folder to be deleted. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
SFTP Download that works either for files or directories. It supports nested folders. SFTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| DestinationPath |
NO |
The destination path, which can be a local file or a remote sftp location. |
| SourcePath |
NO |
The source path, which can be a local file or a remote sftp location |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The source path, which can be a local file or a remote sftp location |
| DestinationPath |
NO |
The destination path, which can be a local file or a remote sftp location. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Uploads a file or a directory to a remote directory using SFTP. It supports nested directories. SFTP User/Passwd must be configured on filemanager.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePath |
NO |
The path to the file or directory that must be uploaded. |
| DestinationPath |
NO |
The sftp url of directory where the local file or directory will be uploaded to. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
check if the given path(file or directory) exists or not
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
Path of file or directory |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| FileExistence |
File existence flag, true when file exists, false when file does not exist |
check if the path(file or directory) can be read or not
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
Path of file or directory |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| FileReadable |
True when file can be read, false when file cannot be read |
Asynchronously Move the contents of a folder from the source folder to the destination folder. If the destination folder does not exist, it is created. Only contents match the filter will be moved. If no filter is supplied, then all the files will be moved.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to move contents |
| destinationDir |
NO |
The new directory path to which to move the contents |
| filter |
NO |
a regular expression to filter contents(includes files and directories) under dir that need to move to destinationDir |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
Asynchronously move the contents of a folder to a destination folder
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| dir |
NO |
The directory path from which to move contents |
| destinationDir |
NO |
The new directory path to which to move the contents |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
It will firstly delete the path(file or directory) rootPath/subPath, then recursively delete its parents of subPath if it's empty. Do not delete rootPath although it's empty.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| rootPath |
NO |
A root path as a prefix of the subPath. |
| subPath |
NO |
DO NOT have .. and . in the path. It may cause unexpected result. Otherwise, please make sure which path need to delete. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
check if the the given path is a file or not
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Path |
NO |
Path of file or directory |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| IsFile |
True when given path is a file, false when it's directory |
This message is used for batch move the file instead of looping and call FMS for every file.
Internal use only.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| SourcePathList |
NO |
List of string that owns all the source paths separated by comma. |
| DestinationPathList |
NO |
List of string that specifies all the destination paths separated by comma. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
search file under specific folder with a filter(a regex), return a list of the file path of all the files that matches the pattern.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| Directory |
NO |
The directory path |
| Filter |
NO |
The file filter, e.g file full name, or a regex |
| IsSubFolderIncluded |
NO |
Whether including sub folder |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| FileList |
a list of the file path |
| © 2002 - 2020 Ericsson Television Inc. |
| All Rights Reserved. |